| Class: LSAGlossaryReferenceS |
Maintaines a list of Glossary references.
- Version:
-
1.2.2, 08.JUN.2000
- History:
| 08.JUN.2000 | RGR | Delete method changed
|
Public Property Set ManagerID AsString
Sets ID of the manager class object. This class has to provide the access to the functions of
the corresponding glosssary db.
Public Property Get ManagerID AsString
Public Property Get ManagerInstance AsVariant
Returns the manager class object. This class has to provide the access to the functions of
the corresponding glosssary db.
Public Property Set BlockUpdate AsVariant
Sets the attribute that prevents the keywords from being updated
- Parameters:
| BlockUpdate | Variant | a non blank string or the boolean true sets the attribute everything other resets it
|
Public Property Set DisplayColumn AsInteger
Sets the attribute that prevents the keywords from being updated
- Parameters:
| BlockUpdate | Variant | a non blank string or the boolean true sets the attribute everything other resets it
|
Public Property Get DisplayColumn AsInteger
Public Property Set Prefix AsString
Sets the attribute that prevents the keywords from being updated
- Parameters:
| BlockUpdate | Variant | a non blank string or the boolean true sets the attribute everything other resets it
|
New
Public Sub New(ManagerID As String)
Initializes the list.
Delete
Public Sub Delete
Default destructor of the class. Deletes all child objects
- History:
| 08.JUN.2000 | RGR | Delete the children
|
AddItem
Public Sub AddItem(NewItem As Variant)
Adds a new Keyword Item to the list, The keyword item is a pair consistion
of the internal Reference and the display version of it like
|~|elem2-1~elem2-2~...|elem3-1~elem3-2~... and
elem2-1/elem3-1...
where the element displayed depends on the Tuple column and the prefix.
Each one of the array elements may be "" but not both!
- Parameters:
| newItem | Variant | a two dimensional array
|
ClearCurrentItem
Public Sub ClearCurrentItem
Deletes the current item from the list
ClearAllItems
Public Sub ClearAllItems
Reinitializes the phone list
UpdateCurrentItem
Public Sub UpdateCurrentItem(UpdateItem As Variant)
Updates the current item with the data from the UpdateItem
- Parameters:
| UpdateItem | Variant | a two dimensional array
|
- See also:
SetCurrentItem
Public Sub SetCurrentItem(NewCurrentItem As Variant)
Set the current item to the parameter item
GetCurrentItem
Public Function GetCurrentItem As Variant
Returns the current item of the list
- Returns:
| Variant | a two dimensional array
|
GetFirstItem
Public Function GetFirstItem As Variant
Returns the first item of the list
- Returns:
| Variant | a two dimensional array
|
GetNextItem
Public Function GetNextItem As Variant
Returns the item next to the current item of the list
If the last item is reached the next will be return empty!
- Returns:
| Variant | a two dimensional array
|
GetPreviousItem
Public Function GetPreviousItem As Variant
saveToPredefinedFields
Public Function saveToPredefinedFields(doc As NotesDocument) As Integer
Stores attribute values for the convinience of the programmer. The
fields of documents relate to the subform LSASubPhone from LSL-Address
The attribute are only stored if they differ from the values on disk.
- Parameters:
| doc | NotesDocument | the document in which the attributes are stored
|
- Returns:
| Boolean | true, if an document item has been changed
|
UpdateThisReference
Public Function UpdateThisReference(Reference As String,Keyword As String,Prefix As String,DisplayColumn As Integer) As Integer
It requires
>the reference to be synchronized with,
the format or the reference is like |~|em2-1~elem2-2~...|lem3-1~elem3-2~.....
>the Keyword that may be used to resynchronize
>the prefix that has to be ignored for the external representation
usually word 0 and word 1 (delimiters) can be ignored but you may choose a path to a subtree also
>the display column in the item from which the external name is created,
remember, the item in each level is an tuple like elem1~elem2~...
and returns a true if an update is required. In this case
reference and keyword contain the new values!
ExternalRepresentation
Public Function ExternalRepresentation(Reference As String,DisplayColumn As Integer,PrefixLevel As Integer) As String
It requires the
> reference from which the external representation is created,
format or the reference is like |~|elem2-1~elem2-2~...|elem3-1~elem3-2~...
> display column in the item from which the external name is created,
remember, the item in each level is an tuple like elem1~elem2~... but we can have only one value for display
usually it is 2
>prefixLevel is the index of the llast element to be ignored for the external representation
usually it is1 asword 0 and word 1 (delimiters) can be ignored in a serialized format
and returns a true if an update is required. In this case
reference and keyword contain the new values!
fillFromDoc
Public Sub fillFromDoc(doc As NotesDocument)
Fills the attributes of the current object by reading a set from predefined fields
from the document which is passed in as parameter.
- Parameters:
| doc | NotesDocument | the document which is used to fill the object
|
| Top | LotusScript Doc |
| © Lotus Professional Services |
| generated on : 05-Apr-01 8:45:33 AM |